home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / xcb / screensaver.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-09-17  |  18.9 KB  |  601 lines
  1. /*
  2.  * This file generated automatically from screensaver.xml by c-client.xsl using XSLT.
  3.  * Edit at your peril.
  4.  */
  5.  
  6. /**
  7.  * @defgroup XCB_ScreenSaver_API XCB ScreenSaver API
  8.  * @brief ScreenSaver XCB Protocol Implementation.
  9.  * @{
  10.  **/
  11.  
  12. #ifndef __SCREENSAVER_H
  13. #define __SCREENSAVER_H
  14.  
  15. #include "xcb.h"
  16. #include "xproto.h"
  17.  
  18. #define XCB_SCREENSAVER_MAJOR_VERSION 1
  19. #define XCB_SCREENSAVER_MINOR_VERSION 1
  20.   
  21. extern xcb_extension_t xcb_screensaver_id;
  22.  
  23. typedef enum xcb_screensaver_kind_t {
  24.     XCB_SCREENSAVER_KIND_BLANKED,
  25.     XCB_SCREENSAVER_KIND_INTERNAL,
  26.     XCB_SCREENSAVER_KIND_EXTERNAL
  27. } xcb_screensaver_kind_t;
  28.  
  29. typedef enum xcb_screensaver_event_t {
  30.     XCB_SCREENSAVER_EVENT_NOTIFY_MASK = (1 << 0),
  31.     XCB_SCREENSAVER_EVENT_CYCLE_MASK = (1 << 1)
  32. } xcb_screensaver_event_t;
  33.  
  34. typedef enum xcb_screensaver_state_t {
  35.     XCB_SCREENSAVER_STATE_OFF,
  36.     XCB_SCREENSAVER_STATE_ON,
  37.     XCB_SCREENSAVER_STATE_CYCLE,
  38.     XCB_SCREENSAVER_STATE_DISABLED
  39. } xcb_screensaver_state_t;
  40.  
  41. /**
  42.  * @brief xcb_screensaver_query_version_cookie_t
  43.  **/
  44. typedef struct xcb_screensaver_query_version_cookie_t {
  45.     unsigned int sequence; /**<  */
  46. } xcb_screensaver_query_version_cookie_t;
  47.  
  48. /** Opcode for xcb_screensaver_query_version. */
  49. #define XCB_SCREENSAVER_QUERY_VERSION 0
  50.  
  51. /**
  52.  * @brief xcb_screensaver_query_version_request_t
  53.  **/
  54. typedef struct xcb_screensaver_query_version_request_t {
  55.     uint8_t  major_opcode; /**<  */
  56.     uint8_t  minor_opcode; /**<  */
  57.     uint16_t length; /**<  */
  58.     uint8_t  client_major_version; /**<  */
  59.     uint8_t  client_minor_version; /**<  */
  60.     uint8_t  pad0[2]; /**<  */
  61. } xcb_screensaver_query_version_request_t;
  62.  
  63. /**
  64.  * @brief xcb_screensaver_query_version_reply_t
  65.  **/
  66. typedef struct xcb_screensaver_query_version_reply_t {
  67.     uint8_t  response_type; /**<  */
  68.     uint8_t  pad0; /**<  */
  69.     uint16_t sequence; /**<  */
  70.     uint32_t length; /**<  */
  71.     uint16_t server_major_version; /**<  */
  72.     uint16_t server_minor_version; /**<  */
  73.     uint8_t  pad1[20]; /**<  */
  74. } xcb_screensaver_query_version_reply_t;
  75.  
  76. /**
  77.  * @brief xcb_screensaver_query_info_cookie_t
  78.  **/
  79. typedef struct xcb_screensaver_query_info_cookie_t {
  80.     unsigned int sequence; /**<  */
  81. } xcb_screensaver_query_info_cookie_t;
  82.  
  83. /** Opcode for xcb_screensaver_query_info. */
  84. #define XCB_SCREENSAVER_QUERY_INFO 1
  85.  
  86. /**
  87.  * @brief xcb_screensaver_query_info_request_t
  88.  **/
  89. typedef struct xcb_screensaver_query_info_request_t {
  90.     uint8_t        major_opcode; /**<  */
  91.     uint8_t        minor_opcode; /**<  */
  92.     uint16_t       length; /**<  */
  93.     xcb_drawable_t drawable; /**<  */
  94. } xcb_screensaver_query_info_request_t;
  95.  
  96. /**
  97.  * @brief xcb_screensaver_query_info_reply_t
  98.  **/
  99. typedef struct xcb_screensaver_query_info_reply_t {
  100.     uint8_t      response_type; /**<  */
  101.     uint8_t      state; /**<  */
  102.     uint16_t     sequence; /**<  */
  103.     uint32_t     length; /**<  */
  104.     xcb_window_t saver_window; /**<  */
  105.     uint32_t     ms_until_server; /**<  */
  106.     uint32_t     ms_since_user_input; /**<  */
  107.     uint32_t     event_mask; /**<  */
  108.     uint8_t      kind; /**<  */
  109.     uint8_t      pad0[7]; /**<  */
  110. } xcb_screensaver_query_info_reply_t;
  111.  
  112. /** Opcode for xcb_screensaver_select_input. */
  113. #define XCB_SCREENSAVER_SELECT_INPUT 2
  114.  
  115. /**
  116.  * @brief xcb_screensaver_select_input_request_t
  117.  **/
  118. typedef struct xcb_screensaver_select_input_request_t {
  119.     uint8_t        major_opcode; /**<  */
  120.     uint8_t        minor_opcode; /**<  */
  121.     uint16_t       length; /**<  */
  122.     xcb_drawable_t drawable; /**<  */
  123.     uint32_t       event_mask; /**<  */
  124. } xcb_screensaver_select_input_request_t;
  125.  
  126. /** Opcode for xcb_screensaver_set_attributes. */
  127. #define XCB_SCREENSAVER_SET_ATTRIBUTES 3
  128.  
  129. /**
  130.  * @brief xcb_screensaver_set_attributes_request_t
  131.  **/
  132. typedef struct xcb_screensaver_set_attributes_request_t {
  133.     uint8_t        major_opcode; /**<  */
  134.     uint8_t        minor_opcode; /**<  */
  135.     uint16_t       length; /**<  */
  136.     xcb_drawable_t drawable; /**<  */
  137.     int16_t        x; /**<  */
  138.     int16_t        y; /**<  */
  139.     uint16_t       width; /**<  */
  140.     uint16_t       height; /**<  */
  141.     uint16_t       border_width; /**<  */
  142.     uint8_t        _class; /**<  */
  143.     uint8_t        depth; /**<  */
  144.     xcb_visualid_t visual; /**<  */
  145.     uint32_t       value_mask; /**<  */
  146. } xcb_screensaver_set_attributes_request_t;
  147.  
  148. /** Opcode for xcb_screensaver_unset_attributes. */
  149. #define XCB_SCREENSAVER_UNSET_ATTRIBUTES 4
  150.  
  151. /**
  152.  * @brief xcb_screensaver_unset_attributes_request_t
  153.  **/
  154. typedef struct xcb_screensaver_unset_attributes_request_t {
  155.     uint8_t        major_opcode; /**<  */
  156.     uint8_t        minor_opcode; /**<  */
  157.     uint16_t       length; /**<  */
  158.     xcb_drawable_t drawable; /**<  */
  159. } xcb_screensaver_unset_attributes_request_t;
  160.  
  161. /** Opcode for xcb_screensaver_suspend. */
  162. #define XCB_SCREENSAVER_SUSPEND 5
  163.  
  164. /**
  165.  * @brief xcb_screensaver_suspend_request_t
  166.  **/
  167. typedef struct xcb_screensaver_suspend_request_t {
  168.     uint8_t  major_opcode; /**<  */
  169.     uint8_t  minor_opcode; /**<  */
  170.     uint16_t length; /**<  */
  171.     uint8_t  suspend; /**<  */
  172.     uint8_t  pad0[3]; /**<  */
  173. } xcb_screensaver_suspend_request_t;
  174.  
  175. /** Opcode for xcb_screensaver_notify. */
  176. #define XCB_SCREENSAVER_NOTIFY 0
  177.  
  178. /**
  179.  * @brief xcb_screensaver_notify_event_t
  180.  **/
  181. typedef struct xcb_screensaver_notify_event_t {
  182.     uint8_t         response_type; /**<  */
  183.     uint8_t         code; /**<  */
  184.     uint16_t        sequence; /**<  */
  185.     uint8_t         state; /**<  */
  186.     uint16_t        sequence_number; /**<  */
  187.     xcb_timestamp_t time; /**<  */
  188.     xcb_window_t    root; /**<  */
  189.     xcb_window_t    window; /**<  */
  190.     uint8_t         kind; /**<  */
  191.     uint8_t         forced; /**<  */
  192.     uint8_t         pad0[14]; /**<  */
  193. } xcb_screensaver_notify_event_t;
  194.  
  195. /**
  196.  * Delivers a request to the X server
  197.  * @param c The connection
  198.  * @return A cookie
  199.  *
  200.  * Delivers a request to the X server.
  201.  * 
  202.  */
  203.  
  204. /*****************************************************************************
  205.  **
  206.  ** xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version
  207.  ** 
  208.  ** @param xcb_connection_t *c
  209.  ** @param uint8_t           client_major_version
  210.  ** @param uint8_t           client_minor_version
  211.  ** @returns xcb_screensaver_query_version_cookie_t
  212.  **
  213.  *****************************************************************************/
  214.  
  215. xcb_screensaver_query_version_cookie_t
  216. xcb_screensaver_query_version (xcb_connection_t *c  /**< */,
  217.                                uint8_t           client_major_version  /**< */,
  218.                                uint8_t           client_minor_version  /**< */);
  219.  
  220. /**
  221.  * Delivers a request to the X server
  222.  * @param c The connection
  223.  * @return A cookie
  224.  *
  225.  * Delivers a request to the X server.
  226.  * 
  227.  * This form can be used only if the request will cause
  228.  * a reply to be generated. Any returned error will be
  229.  * placed in the event queue.
  230.  */
  231.  
  232. /*****************************************************************************
  233.  **
  234.  ** xcb_screensaver_query_version_cookie_t xcb_screensaver_query_version_unchecked
  235.  ** 
  236.  ** @param xcb_connection_t *c
  237.  ** @param uint8_t           client_major_version
  238.  ** @param uint8_t           client_minor_version
  239.  ** @returns xcb_screensaver_query_version_cookie_t
  240.  **
  241.  *****************************************************************************/
  242.  
  243. xcb_screensaver_query_version_cookie_t
  244. xcb_screensaver_query_version_unchecked (xcb_connection_t *c  /**< */,
  245.                                          uint8_t           client_major_version  /**< */,
  246.                                          uint8_t           client_minor_version  /**< */);
  247.  
  248. /**
  249.  * Return the reply
  250.  * @param c      The connection
  251.  * @param cookie The cookie
  252.  * @param e      The xcb_generic_error_t supplied
  253.  *
  254.  * Returns the reply of the request asked by
  255.  * 
  256.  * The parameter @p e supplied to this function must be NULL if
  257.  * xcb_screensaver_query_version_unchecked(). is used.
  258.  * Otherwise, it stores the error if any.
  259.  */
  260.  
  261. /*****************************************************************************
  262.  **
  263.  ** xcb_screensaver_query_version_reply_t * xcb_screensaver_query_version_reply
  264.  ** 
  265.  ** @param xcb_connection_t                        *c
  266.  ** @param xcb_screensaver_query_version_cookie_t   cookie
  267.  ** @param xcb_generic_error_t                    **e
  268.  ** @returns xcb_screensaver_query_version_reply_t *
  269.  **
  270.  *****************************************************************************/
  271.  
  272. xcb_screensaver_query_version_reply_t *
  273. xcb_screensaver_query_version_reply (xcb_connection_t                        *c  /**< */,
  274.                                      xcb_screensaver_query_version_cookie_t   cookie  /**< */,
  275.                                      xcb_generic_error_t                    **e  /**< */);
  276.  
  277. /**
  278.  * Delivers a request to the X server
  279.  * @param c The connection
  280.  * @return A cookie
  281.  *
  282.  * Delivers a request to the X server.
  283.  * 
  284.  */
  285.  
  286. /*****************************************************************************
  287.  **
  288.  ** xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info
  289.  ** 
  290.  ** @param xcb_connection_t *c
  291.  ** @param xcb_drawable_t    drawable
  292.  ** @returns xcb_screensaver_query_info_cookie_t
  293.  **
  294.  *****************************************************************************/
  295.  
  296. xcb_screensaver_query_info_cookie_t
  297. xcb_screensaver_query_info (xcb_connection_t *c  /**< */,
  298.                             xcb_drawable_t    drawable  /**< */);
  299.  
  300. /**
  301.  * Delivers a request to the X server
  302.  * @param c The connection
  303.  * @return A cookie
  304.  *
  305.  * Delivers a request to the X server.
  306.  * 
  307.  * This form can be used only if the request will cause
  308.  * a reply to be generated. Any returned error will be
  309.  * placed in the event queue.
  310.  */
  311.  
  312. /*****************************************************************************
  313.  **
  314.  ** xcb_screensaver_query_info_cookie_t xcb_screensaver_query_info_unchecked
  315.  ** 
  316.  ** @param xcb_connection_t *c
  317.  ** @param xcb_drawable_t    drawable
  318.  ** @returns xcb_screensaver_query_info_cookie_t
  319.  **
  320.  *****************************************************************************/
  321.  
  322. xcb_screensaver_query_info_cookie_t
  323. xcb_screensaver_query_info_unchecked (xcb_connection_t *c  /**< */,
  324.                                       xcb_drawable_t    drawable  /**< */);
  325.  
  326. /**
  327.  * Return the reply
  328.  * @param c      The connection
  329.  * @param cookie The cookie
  330.  * @param e      The xcb_generic_error_t supplied
  331.  *
  332.  * Returns the reply of the request asked by
  333.  * 
  334.  * The parameter @p e supplied to this function must be NULL if
  335.  * xcb_screensaver_query_info_unchecked(). is used.
  336.  * Otherwise, it stores the error if any.
  337.  */
  338.  
  339. /*****************************************************************************
  340.  **
  341.  ** xcb_screensaver_query_info_reply_t * xcb_screensaver_query_info_reply
  342.  ** 
  343.  ** @param xcb_connection_t                     *c
  344.  ** @param xcb_screensaver_query_info_cookie_t   cookie
  345.  ** @param xcb_generic_error_t                 **e
  346.  ** @returns xcb_screensaver_query_info_reply_t *
  347.  **
  348.  *****************************************************************************/
  349.  
  350. xcb_screensaver_query_info_reply_t *
  351. xcb_screensaver_query_info_reply (xcb_connection_t                     *c  /**< */,
  352.                                   xcb_screensaver_query_info_cookie_t   cookie  /**< */,
  353.                                   xcb_generic_error_t                 **e  /**< */);
  354.  
  355. /**
  356.  * Delivers a request to the X server
  357.  * @param c The connection
  358.  * @return A cookie
  359.  *
  360.  * Delivers a request to the X server.
  361.  * 
  362.  * This form can be used only if the request will not cause
  363.  * a reply to be generated. Any returned error will be
  364.  * saved for handling by xcb_request_check().
  365.  */
  366.  
  367. /*****************************************************************************
  368.  **
  369.  ** xcb_void_cookie_t xcb_screensaver_select_input_checked
  370.  ** 
  371.  ** @param xcb_connection_t *c
  372.  ** @param xcb_drawable_t    drawable
  373.  ** @param uint32_t          event_mask
  374.  ** @returns xcb_void_cookie_t
  375.  **
  376.  *****************************************************************************/
  377.  
  378. xcb_void_cookie_t
  379. xcb_screensaver_select_input_checked (xcb_connection_t *c  /**< */,
  380.                                       xcb_drawable_t    drawable  /**< */,
  381.                                       uint32_t          event_mask  /**< */);
  382.  
  383. /**
  384.  * Delivers a request to the X server
  385.  * @param c The connection
  386.  * @return A cookie
  387.  *
  388.  * Delivers a request to the X server.
  389.  * 
  390.  */
  391.  
  392. /*****************************************************************************
  393.  **
  394.  ** xcb_void_cookie_t xcb_screensaver_select_input
  395.  ** 
  396.  ** @param xcb_connection_t *c
  397.  ** @param xcb_drawable_t    drawable
  398.  ** @param uint32_t          event_mask
  399.  ** @returns xcb_void_cookie_t
  400.  **
  401.  *****************************************************************************/
  402.  
  403. xcb_void_cookie_t
  404. xcb_screensaver_select_input (xcb_connection_t *c  /**< */,
  405.                               xcb_drawable_t    drawable  /**< */,
  406.                               uint32_t          event_mask  /**< */);
  407.  
  408. /**
  409.  * Delivers a request to the X server
  410.  * @param c The connection
  411.  * @return A cookie
  412.  *
  413.  * Delivers a request to the X server.
  414.  * 
  415.  * This form can be used only if the request will not cause
  416.  * a reply to be generated. Any returned error will be
  417.  * saved for handling by xcb_request_check().
  418.  */
  419.  
  420. /*****************************************************************************
  421.  **
  422.  ** xcb_void_cookie_t xcb_screensaver_set_attributes_checked
  423.  ** 
  424.  ** @param xcb_connection_t *c
  425.  ** @param xcb_drawable_t    drawable
  426.  ** @param int16_t           x
  427.  ** @param int16_t           y
  428.  ** @param uint16_t          width
  429.  ** @param uint16_t          height
  430.  ** @param uint16_t          border_width
  431.  ** @param uint8_t           _class
  432.  ** @param uint8_t           depth
  433.  ** @param xcb_visualid_t    visual
  434.  ** @param uint32_t          value_mask
  435.  ** @param const uint32_t   *value_list
  436.  ** @returns xcb_void_cookie_t
  437.  **
  438.  *****************************************************************************/
  439.  
  440. xcb_void_cookie_t
  441. xcb_screensaver_set_attributes_checked (xcb_connection_t *c  /**< */,
  442.                                         xcb_drawable_t    drawable  /**< */,
  443.                                         int16_t           x  /**< */,
  444.                                         int16_t           y  /**< */,
  445.                                         uint16_t          width  /**< */,
  446.                                         uint16_t          height  /**< */,
  447.                                         uint16_t          border_width  /**< */,
  448.                                         uint8_t           _class  /**< */,
  449.                                         uint8_t           depth  /**< */,
  450.                                         xcb_visualid_t    visual  /**< */,
  451.                                         uint32_t          value_mask  /**< */,
  452.                                         const uint32_t   *value_list  /**< */);
  453.  
  454. /**
  455.  * Delivers a request to the X server
  456.  * @param c The connection
  457.  * @return A cookie
  458.  *
  459.  * Delivers a request to the X server.
  460.  * 
  461.  */
  462.  
  463. /*****************************************************************************
  464.  **
  465.  ** xcb_void_cookie_t xcb_screensaver_set_attributes
  466.  ** 
  467.  ** @param xcb_connection_t *c
  468.  ** @param xcb_drawable_t    drawable
  469.  ** @param int16_t           x
  470.  ** @param int16_t           y
  471.  ** @param uint16_t          width
  472.  ** @param uint16_t          height
  473.  ** @param uint16_t          border_width
  474.  ** @param uint8_t           _class
  475.  ** @param uint8_t           depth
  476.  ** @param xcb_visualid_t    visual
  477.  ** @param uint32_t          value_mask
  478.  ** @param const uint32_t   *value_list
  479.  ** @returns xcb_void_cookie_t
  480.  **
  481.  *****************************************************************************/
  482.  
  483. xcb_void_cookie_t
  484. xcb_screensaver_set_attributes (xcb_connection_t *c  /**< */,
  485.                                 xcb_drawable_t    drawable  /**< */,
  486.                                 int16_t           x  /**< */,
  487.                                 int16_t           y  /**< */,
  488.                                 uint16_t          width  /**< */,
  489.                                 uint16_t          height  /**< */,
  490.                                 uint16_t          border_width  /**< */,
  491.                                 uint8_t           _class  /**< */,
  492.                                 uint8_t           depth  /**< */,
  493.                                 xcb_visualid_t    visual  /**< */,
  494.                                 uint32_t          value_mask  /**< */,
  495.                                 const uint32_t   *value_list  /**< */);
  496.  
  497. /**
  498.  * Delivers a request to the X server
  499.  * @param c The connection
  500.  * @return A cookie
  501.  *
  502.  * Delivers a request to the X server.
  503.  * 
  504.  * This form can be used only if the request will not cause
  505.  * a reply to be generated. Any returned error will be
  506.  * saved for handling by xcb_request_check().
  507.  */
  508.  
  509. /*****************************************************************************
  510.  **
  511.  ** xcb_void_cookie_t xcb_screensaver_unset_attributes_checked
  512.  ** 
  513.  ** @param xcb_connection_t *c
  514.  ** @param xcb_drawable_t    drawable
  515.  ** @returns xcb_void_cookie_t
  516.  **
  517.  *****************************************************************************/
  518.  
  519. xcb_void_cookie_t
  520. xcb_screensaver_unset_attributes_checked (xcb_connection_t *c  /**< */,
  521.                                           xcb_drawable_t    drawable  /**< */);
  522.  
  523. /**
  524.  * Delivers a request to the X server
  525.  * @param c The connection
  526.  * @return A cookie
  527.  *
  528.  * Delivers a request to the X server.
  529.  * 
  530.  */
  531.  
  532. /*****************************************************************************
  533.  **
  534.  ** xcb_void_cookie_t xcb_screensaver_unset_attributes
  535.  ** 
  536.  ** @param xcb_connection_t *c
  537.  ** @param xcb_drawable_t    drawable
  538.  ** @returns xcb_void_cookie_t
  539.  **
  540.  *****************************************************************************/
  541.  
  542. xcb_void_cookie_t
  543. xcb_screensaver_unset_attributes (xcb_connection_t *c  /**< */,
  544.                                   xcb_drawable_t    drawable  /**< */);
  545.  
  546. /**
  547.  * Delivers a request to the X server
  548.  * @param c The connection
  549.  * @return A cookie
  550.  *
  551.  * Delivers a request to the X server.
  552.  * 
  553.  * This form can be used only if the request will not cause
  554.  * a reply to be generated. Any returned error will be
  555.  * saved for handling by xcb_request_check().
  556.  */
  557.  
  558. /*****************************************************************************
  559.  **
  560.  ** xcb_void_cookie_t xcb_screensaver_suspend_checked
  561.  ** 
  562.  ** @param xcb_connection_t *c
  563.  ** @param uint8_t           suspend
  564.  ** @returns xcb_void_cookie_t
  565.  **
  566.  *****************************************************************************/
  567.  
  568. xcb_void_cookie_t
  569. xcb_screensaver_suspend_checked (xcb_connection_t *c  /**< */,
  570.                                  uint8_t           suspend  /**< */);
  571.  
  572. /**
  573.  * Delivers a request to the X server
  574.  * @param c The connection
  575.  * @return A cookie
  576.  *
  577.  * Delivers a request to the X server.
  578.  * 
  579.  */
  580.  
  581. /*****************************************************************************
  582.  **
  583.  ** xcb_void_cookie_t xcb_screensaver_suspend
  584.  ** 
  585.  ** @param xcb_connection_t *c
  586.  ** @param uint8_t           suspend
  587.  ** @returns xcb_void_cookie_t
  588.  **
  589.  *****************************************************************************/
  590.  
  591. xcb_void_cookie_t
  592. xcb_screensaver_suspend (xcb_connection_t *c  /**< */,
  593.                          uint8_t           suspend  /**< */);
  594.  
  595.  
  596. #endif
  597.  
  598. /**
  599.  * @}
  600.  */
  601.